/*
CpGears v1.0

Copyright (c) 2010 Yves Riel http://www.flash-factor.com

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
package cpgears.movie.slide {
	import flash.display.MovieClip;
	
	/**
	 * A Captivate Slide.
	 * 
	 * @author Whyves
	 */
	public interface ISlide {
		
		/**
		 * Prevents the Captivate Pacemaker to skip a specific frame.
		 * 
		 * <P>Captivate uses a "Pacemaker" functionality to manage system resources. The Pacemaker will skip movie frames to keep the movie
		 * responsive when system resources are low.</P>
		 * 
		 * <P>Use this function if you have important actionscript that is running on a specific frame. This way, the Pacemaker
		 * will always run the frame even when resources are low.</P>
		 * 
		 * @param	frameNum The frame number which should not be skipped.
		 */
		function addNoSkipFrame(frameNum:Number) :void

		/**
		 * The frame number at which the slide begins.
		 */
		function get startFrame():Number
		
		/**
		 * The frame number at which the slide ends.
		 */
		function get endFrame():Number
		 
		 /**
		  * Returns the name (label) of the Current Slide in the Captivate properties panel.
		  */
		 function get slideLabel():String; 
		 
		 /**
		  * Returns the type of slide currently playing (Slide type can be Normal Slide, Question Slide, or Random Question Slide).
		  */
		 function get slideTypeLabel():String;
		
		/**
		 * The slide type.
		 */
		function get slideType():SlideType
		
		/**
		 * Returns the Slide's movieclip i.e. the Slide's container.
		 */
		function get handle():MovieClip;
	}
	
}